home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 November / SGI Freeware 1999 November - Disc 1.iso / dist / fw_cvs.idb / usr / freeware / info / cvs.info-1.z / cvs.info-1 (.txt)
GNU Info File  |  1999-04-16  |  50KB  |  887 lines
  1. This is Info file cvs.info, produced by Makeinfo version 1.67 from the
  2. input file ./cvs.texinfo.
  3. START-INFO-DIR-ENTRY
  4. * CVS: (cvs).          Concurrent Versions System
  5. END-INFO-DIR-ENTRY
  6.    Copyright (C) 1992, 1993 Signum Support AB Copyright (C) 1993, 1994
  7. Free Software Foundation, Inc.
  8.    Permission is granted to make and distribute verbatim copies of this
  9. manual provided the copyright notice and this permission notice are
  10. preserved on all copies.
  11.    Permission is granted to copy and distribute modified versions of
  12. this manual under the conditions for verbatim copying, provided also
  13. that the entire resulting derived work is distributed under the terms
  14. of a permission notice identical to this one.
  15.    Permission is granted to copy and distribute translations of this
  16. manual into another language, under the above conditions for modified
  17. versions, except that this permission notice may be stated in a
  18. translation approved by the Free Software Foundation.
  19. File: cvs.info,  Node: Top,  Next: Overview,  Up: (dir)
  20.    This info manual describes how to use and administer CVS version
  21. 1.10.
  22. * Menu:
  23. * Overview::                    An introduction to CVS
  24. * Repository::                  Where all your sources are stored
  25. * Starting a new project::      Starting a project with CVS
  26. * Revisions::                   Numeric and symbolic names for revisions
  27. * Branching and merging::       Diverging/rejoining branches of development
  28. * Recursive behavior::          CVS descends directories
  29. * Adding and removing::         Adding/removing/renaming files/directories
  30. * History browsing::            Viewing the history of files in various ways
  31. CVS and the Real World.
  32. ----------------------
  33. * Binary files::                CVS can handle binary files
  34. * Multiple developers::         How CVS helps a group of developers
  35. * Revision management::         Policy questions for revision management
  36. * Keyword substitution::        CVS can include the revision inside the file
  37. * Tracking sources::            Tracking third-party sources
  38. * Builds::                      Issues related to CVS and builds
  39. * Special Files::        Devices, links and other non-regular files
  40. References.
  41. ----------
  42. * CVS commands::                CVS commands share some things
  43. * Invoking CVS::                Quick reference to CVS commands
  44. * Administrative files::        Reference manual for the Administrative files
  45. * Environment variables::       All environment variables which affect CVS
  46. * Compatibility::               Upgrading CVS versions
  47. * Troubleshooting::             Some tips when nothing works
  48. * Credits::                     Some of the contributors to this manual
  49. * BUGS::                        Dealing with bugs in CVS or this manual
  50. * Index::                       Index
  51. File: cvs.info,  Node: Overview,  Next: Repository,  Prev: Top,  Up: Top
  52. Overview
  53. ********
  54.    This chapter is for people who have never used CVS, and perhaps have
  55. never used version control software before.
  56.    If you are already familiar with CVS and are just trying to learn a
  57. particular feature or remember a certain command, you can probably skip
  58. everything here.
  59. * Menu:
  60. * What is CVS?::                What you can do with CVS
  61. * What is CVS not?::            Problems CVS doesn't try to solve
  62. * A sample session::            A tour of basic CVS usage
  63. File: cvs.info,  Node: What is CVS?,  Next: What is CVS not?,  Up: Overview
  64. What is CVS?
  65. ============
  66.    CVS is a version control system.  Using it, you can record the
  67. history of your source files.
  68.    For example, bugs sometimes creep in when software is modified, and
  69. you might not detect the bug until a long time after you make the
  70. modification.  With CVS, you can easily retrieve old versions to see
  71. exactly which change caused the bug.  This can sometimes be a big help.
  72.    You could of course save every version of every file you have ever
  73. created.  This would however waste an enormous amount of disk space.
  74. CVS stores all the versions of a file in a single file in a clever way
  75. that only stores the differences between versions.
  76.    CVS also helps you if you are part of a group of people working on
  77. the same project.  It is all too easy to overwrite each others' changes
  78. unless you are extremely careful.  Some editors, like GNU Emacs, try to
  79. make sure that the same file is never modified by two people at the
  80. same time.  Unfortunately, if someone is using another editor, that
  81. safeguard will not work.  CVS solves this problem by insulating the
  82. different developers from each other.  Every developer works in his own
  83. directory, and CVS merges the work when each developer is done.
  84.    CVS started out as a bunch of shell scripts written by Dick Grune,
  85. posted to the newsgroup `comp.sources.unix' in the volume 6 release of
  86. December, 1986.  While no actual code from these shell scripts is
  87. present in the current version of CVS much of the CVS conflict
  88. resolution algorithms come from them.
  89.    In April, 1989, Brian Berliner designed and coded CVS.  Jeff Polk
  90. later helped Brian with the design of the CVS module and vendor branch
  91. support.
  92.    You can get CVS in a variety of ways, including free download from
  93. the internet.  For more information on downloading CVS and other CVS
  94. topics, see:
  95.      http://www.cyclic.com/
  96.      http://www.loria.fr/~molli/cvs-index.html
  97.    There is a mailing list, known as `info-cvs', devoted to CVS.  To
  98. subscribe or unsubscribe write to `info-cvs-request@gnu.org'.  If you
  99. prefer a usenet group, the right group is `comp.software.config-mgmt'
  100. which is for CVS discussions (along with other configuration management
  101. systems).  In the future, it might be possible to create a
  102. `comp.software.config-mgmt.cvs', but probably only if there is
  103. sufficient CVS traffic on `comp.software.config-mgmt'.
  104.    You can also subscribe to the bug-cvs mailing list, described in
  105. more detail in *Note BUGS::.  To subscribe send mail to
  106. bug-cvs-request@gnu.org.
  107. File: cvs.info,  Node: What is CVS not?,  Next: A sample session,  Prev: What is CVS?,  Up: Overview
  108. What is CVS not?
  109. ================
  110.    CVS can do a lot of things for you, but it does not try to be
  111. everything for everyone.
  112. CVS is not a build system.
  113.      Though the structure of your repository and modules file interact
  114.      with your build system (e.g. `Makefile's), they are essentially
  115.      independent.
  116.      CVS does not dictate how you build anything.  It merely stores
  117.      files for retrieval in a tree structure you devise.
  118.      CVS does not dictate how to use disk space in the checked out
  119.      working directories.  If you write your `Makefile's or scripts in
  120.      every directory so they have to know the relative positions of
  121.      everything else, you wind up requiring the entire repository to be
  122.      checked out.
  123.      If you modularize your work, and construct a build system that
  124.      will share files (via links, mounts, `VPATH' in `Makefile's,
  125.      etc.), you can arrange your disk usage however you like.
  126.      But you have to remember that *any* such system is a lot of work
  127.      to construct and maintain.  CVS does not address the issues
  128.      involved.
  129.      Of course, you should place the tools created to support such a
  130.      build system (scripts, `Makefile's, etc) under CVS.
  131.      Figuring out what files need to be rebuilt when something changes
  132.      is, again, something to be handled outside the scope of CVS.  One
  133.      traditional approach is to use `make' for building, and use some
  134.      automated tool for generating the dependencies which `make' uses.
  135.      See *Note Builds::, for more information on doing builds in
  136.      conjunction with CVS.
  137. CVS is not a substitute for management.
  138.      Your managers and project leaders are expected to talk to you
  139.      frequently enough to make certain you are aware of schedules,
  140.      merge points, branch names and release dates.  If they don't, CVS
  141.      can't help.
  142.      CVS is an instrument for making sources dance to your tune.  But
  143.      you are the piper and the composer.  No instrument plays itself or
  144.      writes its own music.
  145. CVS is not a substitute for developer communication.
  146.      When faced with conflicts within a single file, most developers
  147.      manage to resolve them without too much effort.  But a more
  148.      general definition of "conflict" includes problems too difficult
  149.      to solve without communication between developers.
  150.      CVS cannot determine when simultaneous changes within a single
  151.      file, or across a whole collection of files, will logically
  152.      conflict with one another.  Its concept of a "conflict" is purely
  153.      textual, arising when two changes to the same base file are near
  154.      enough to spook the merge (i.e. `diff3') command.
  155.      CVS does not claim to help at all in figuring out non-textual or
  156.      distributed conflicts in program logic.
  157.      For example: Say you change the arguments to function `X' defined
  158.      in file `A'.  At the same time, someone edits file `B', adding new
  159.      calls to function `X' using the old arguments.  You are outside
  160.      the realm of CVS's competence.
  161.      Acquire the habit of reading specs and talking to your peers.
  162. CVS does not have change control
  163.      Change control refers to a number of things.  First of all it can
  164.      mean "bug-tracking", that is being able to keep a database of
  165.      reported bugs and the status of each one (is it fixed?  in what
  166.      release?  has the bug submitter agreed that it is fixed?).  For
  167.      interfacing CVS to an external bug-tracking system, see the
  168.      `rcsinfo' and `verifymsg' files (*note Administrative files::.).
  169.      Another aspect of change control is keeping track of the fact that
  170.      changes to several files were in fact changed together as one
  171.      logical change.  If you check in several files in a single `cvs
  172.      commit' operation, CVS then forgets that those files were checked
  173.      in together, and the fact that they have the same log message is
  174.      the only thing tying them together.  Keeping a GNU style
  175.      `ChangeLog' can help somewhat.
  176.      Another aspect of change control, in some systems, is the ability
  177.      to keep track of the status of each change.  Some changes have
  178.      been written by a developer, others have been reviewed by a second
  179.      developer, and so on.  Generally, the way to do this with CVS is to
  180.      generate a diff (using `cvs diff' or `diff') and email it to
  181.      someone who can then apply it using the `patch' utility.  This is
  182.      very flexible, but depends on mechanisms outside CVS to make sure
  183.      nothing falls through the cracks.
  184. CVS is not an automated testing program
  185.      It should be possible to enforce mandatory use of a testsuite
  186.      using the `commitinfo' file.  I haven't heard a lot about projects
  187.      trying to do that or whether there are subtle gotchas, however.
  188. CVS does not have a builtin process model
  189.      Some systems provide ways to ensure that changes or releases go
  190.      through various steps, with various approvals as needed.
  191.      Generally, one can accomplish this with CVS but it might be a
  192.      little more work.  In some cases you'll want to use the
  193.      `commitinfo', `loginfo', `rcsinfo', or `verifymsg' files, to
  194.      require that certain steps be performed before cvs will allow a
  195.      checkin.  Also consider whether features such as branches and tags
  196.      can be used to perform tasks such as doing work in a development
  197.      tree and then merging certain changes over to a stable tree only
  198.      once they have been proven.
  199. File: cvs.info,  Node: A sample session,  Prev: What is CVS not?,  Up: Overview
  200. A sample session
  201. ================
  202.    As a way of introducing CVS, we'll go through a typical work-session
  203. using CVS.  The first thing to understand is that CVS stores all files
  204. in a centralized "repository" (*note Repository::.); this section
  205. assumes that a repository is set up.
  206.    Suppose you are working on a simple compiler.  The source consists
  207. of a handful of C files and a `Makefile'.  The compiler is called `tc'
  208. (Trivial Compiler), and the repository is set up so that there is a
  209. module called `tc'.
  210. * Menu:
  211. * Getting the source::          Creating a workspace
  212. * Committing your changes::     Making your work available to others
  213. * Cleaning up::                 Cleaning up
  214. * Viewing differences::         Viewing differences
  215. File: cvs.info,  Node: Getting the source,  Next: Committing your changes,  Up: A sample session
  216. Getting the source
  217. ------------------
  218.    The first thing you must do is to get your own working copy of the
  219. source for `tc'.  For this, you use the `checkout' command:
  220.      $ cvs checkout tc
  221. This will create a new directory called `tc' and populate it with the
  222. source files.
  223.      $ cd tc
  224.      $ ls
  225.      CVS         Makefile    backend.c   driver.c    frontend.c  parser.c
  226.    The `CVS' directory is used internally by CVS.  Normally, you should
  227. not modify or remove any of the files in it.
  228.    You start your favorite editor, hack away at `backend.c', and a
  229. couple of hours later you have added an optimization pass to the
  230. compiler.  A note to RCS and SCCS users: There is no need to lock the
  231. files that you want to edit.  *Note Multiple developers::, for an
  232. explanation.
  233. File: cvs.info,  Node: Committing your changes,  Next: Cleaning up,  Prev: Getting the source,  Up: A sample session
  234. Committing your changes
  235. -----------------------
  236.    When you have checked that the compiler is still compilable you
  237. decide to make a new version of `backend.c'.  This will store your new
  238. `backend.c' in the repository and make it available to anyone else who
  239. is using that same repository.
  240.      $ cvs commit backend.c
  241. CVS starts an editor, to allow you to enter a log message.  You type in
  242. "Added an optimization pass.", save the temporary file, and exit the
  243. editor.
  244.    The environment variable `$CVSEDITOR' determines which editor is
  245. started.  If `$CVSEDITOR' is not set, then if the environment variable
  246. `$EDITOR' is set, it will be used. If both `$CVSEDITOR' and `$EDITOR'
  247. are not set then there is a default which will vary with your operating
  248. system, for example `vi' for unix or `notepad' for Windows NT/95.
  249.    When CVS starts the editor, it includes a list of files which are
  250. modified.  For the CVS client, this list is based on comparing the
  251. modification time of the file against the modification time that the
  252. file had when it was last gotten or updated.  Therefore, if a file's
  253. modification time has changed but its contents have not, it will show
  254. up as modified.  The simplest way to handle this is simply not to worry
  255. about it--if you proceed with the commit CVS will detect that the
  256. contents are not modified and treat it as an unmodified file.  The next
  257. `update' will clue CVS in to the fact that the file is unmodified, and
  258. it will reset its stored timestamp so that the file will not show up in
  259. future editor sessions.
  260.    If you want to avoid starting an editor you can specify the log
  261. message on the command line using the `-m' flag instead, like this:
  262.      $ cvs commit -m "Added an optimization pass" backend.c
  263. File: cvs.info,  Node: Cleaning up,  Next: Viewing differences,  Prev: Committing your changes,  Up: A sample session
  264. Cleaning up
  265. -----------
  266.    Before you turn to other tasks you decide to remove your working
  267. copy of tc.  One acceptable way to do that is of course
  268.      $ cd ..
  269.      $ rm -r tc
  270. but a better way is to use the `release' command (*note release::.):
  271.      $ cd ..
  272.      $ cvs release -d tc
  273.      M driver.c
  274.      ? tc
  275.      You have [1] altered files in this repository.
  276.      Are you sure you want to release (and delete) module `tc': n
  277.      ** `release' aborted by user choice.
  278.    The `release' command checks that all your modifications have been
  279. committed.  If history logging is enabled it also makes a note in the
  280. history file.  *Note history file::.
  281.    When you use the `-d' flag with `release', it also removes your
  282. working copy.
  283.    In the example above, the `release' command wrote a couple of lines
  284. of output.  `? tc' means that the file `tc' is unknown to CVS.  That is
  285. nothing to worry about: `tc' is the executable compiler, and it should
  286. not be stored in the repository.  *Note cvsignore::, for information
  287. about how to make that warning go away.  *Note release output::, for a
  288. complete explanation of all possible output from `release'.
  289.    `M driver.c' is more serious.  It means that the file `driver.c' has
  290. been modified since it was checked out.
  291.    The `release' command always finishes by telling you how many
  292. modified files you have in your working copy of the sources, and then
  293. asks you for confirmation before deleting any files or making any note
  294. in the history file.
  295.    You decide to play it safe and answer `n <RET>' when `release' asks
  296. for confirmation.
  297. File: cvs.info,  Node: Viewing differences,  Prev: Cleaning up,  Up: A sample session
  298. Viewing differences
  299. -------------------
  300.    You do not remember modifying `driver.c', so you want to see what
  301. has happened to that file.
  302.      $ cd tc
  303.      $ cvs diff driver.c
  304.    This command runs `diff' to compare the version of `driver.c' that
  305. you checked out with your working copy.  When you see the output you
  306. remember that you added a command line option that enabled the
  307. optimization pass.  You check it in, and release the module.
  308.      $ cvs commit -m "Added an optimization pass" driver.c
  309.      Checking in driver.c;
  310.      /usr/local/cvsroot/tc/driver.c,v  <--  driver.c
  311.      new revision: 1.2; previous revision: 1.1
  312.      done
  313.      $ cd ..
  314.      $ cvs release -d tc
  315.      ? tc
  316.      You have [0] altered files in this repository.
  317.      Are you sure you want to release (and delete) module `tc': y
  318. File: cvs.info,  Node: Repository,  Next: Starting a new project,  Prev: Overview,  Up: Top
  319. The Repository
  320. **************
  321.    The CVS "repository" stores a complete copy of all the files and
  322. directories which are under version control.
  323.    Normally, you never access any of the files in the repository
  324. directly.  Instead, you use CVS commands to get your own copy of the
  325. files into a "working directory", and then work on that copy.  When
  326. you've finished a set of changes, you check (or "commit") them back
  327. into the repository.  The repository then contains the changes which
  328. you have made, as well as recording exactly what you changed, when you
  329. changed it, and other such information.  Note that the repository is
  330. not a subdirectory of the working directory, or vice versa; they should
  331. be in separate locations.
  332.    CVS can access a repository by a variety of means.  It might be on
  333. the local computer, or it might be on a computer across the room or
  334. across the world.  To distinguish various ways to access a repository,
  335. the repository name can start with an "access method".  For example,
  336. the access method `:local:' means to access a repository directory, so
  337. the repository `:local:/usr/local/cvsroot' means that the repository is
  338. in `/usr/local/cvsroot' on the computer running CVS.  For information
  339. on other access methods, see *Note Remote repositories::.
  340.    If the access method is omitted, then if the repository does not
  341. contain `:', then `:local:' is assumed.  If it does contain `:' then
  342. either `:ext:' or `:server:' is assumed.  For example, if you have a
  343. local repository in `/usr/local/cvsroot', you can use
  344. `/usr/local/cvsroot' instead of `:local:/usr/local/cvsroot'.  But if
  345. (under Windows NT, for example) your local repository is
  346. `c:\src\cvsroot', then you must specify the access method, as in
  347. `:local:c:\src\cvsroot'.
  348.    The repository is split in two parts.  `$CVSROOT/CVSROOT' contains
  349. administrative files for CVS.  The other directories contain the actual
  350. user-defined modules.
  351. * Menu:
  352. * Specifying a repository::     Telling CVS where your repository is
  353. * Repository storage::          The structure of the repository
  354. * Working directory storage::   The structure of working directories
  355. * Intro administrative files::  Defining modules
  356. * Multiple repositories::       Multiple repositories
  357. * Creating a repository::       Creating a repository
  358. * Backing up::                  Backing up a repository
  359. * Moving a repository::         Moving a repository
  360. * Remote repositories::         Accessing repositories on remote machines
  361. * Read-only access::            Granting read-only access to the repository
  362. * Server temporary directory::  The server creates temporary directories
  363. File: cvs.info,  Node: Specifying a repository,  Next: Repository storage,  Up: Repository
  364. Telling CVS where your repository is
  365. ====================================
  366.    There are several ways to tell CVS where to find the repository.
  367. You can name the repository on the command line explicitly, with the
  368. `-d' (for "directory") option:
  369.      cvs -d /usr/local/cvsroot checkout yoyodyne/tc
  370.    Or you can set the `$CVSROOT' environment variable to an absolute
  371. path to the root of the repository, `/usr/local/cvsroot' in this
  372. example.  To set `$CVSROOT', `csh' and `tcsh' users should have this
  373. line in their `.cshrc' or `.tcshrc' files:
  374.      setenv CVSROOT /usr/local/cvsroot
  375. `sh' and `bash' users should instead have these lines in their
  376. `.profile' or `.bashrc':
  377.      CVSROOT=/usr/local/cvsroot
  378.      export CVSROOT
  379.    A repository specified with `-d' will override the `$CVSROOT'
  380. environment variable.  Once you've checked a working copy out from the
  381. repository, it will remember where its repository is (the information
  382. is recorded in the `CVS/Root' file in the working copy).
  383.    The `-d' option and the `CVS/Root' file both override the `$CVSROOT'
  384. environment variable.  If `-d' option differs from `CVS/Root', the
  385. former is used (and specifying `-d' will cause `CVS/Root' to be
  386. updated).  Of course, for proper operation they should be two ways of
  387. referring to the same repository.
  388. File: cvs.info,  Node: Repository storage,  Next: Working directory storage,  Prev: Specifying a repository,  Up: Repository
  389. How data is stored in the repository
  390. ====================================
  391.    For most purposes it isn't important *how* CVS stores information in
  392. the repository.  In fact, the format has changed in the past, and is
  393. likely to change in the future.  Since in almost all cases one accesses
  394. the repository via CVS commands, such changes need not be disruptive.
  395.    However, in some cases it may be necessary to understand how CVS
  396. stores data in the repository, for example you might need to track down
  397. CVS locks (*note Concurrency::.) or you might need to deal with the
  398. file permissions appropriate for the repository.
  399. * Menu:
  400. * Repository files::            What files are stored in the repository
  401. * File permissions::            File permissions
  402. * Windows permissions::         Issues specific to Windows
  403. * Attic::                       Some files are stored in the Attic
  404. * CVS in repository::           Additional information in CVS directory
  405. * Locks::                       CVS locks control concurrent accesses
  406. * CVSROOT storage::             A few things about CVSROOT are different
  407. File: cvs.info,  Node: Repository files,  Next: File permissions,  Up: Repository storage
  408. Where files are stored within the repository
  409. --------------------------------------------
  410.    The overall structure of the repository is a directory tree
  411. corresponding to the directories in the working directory.  For
  412. example, supposing the repository is in
  413.      /usr/local/cvsroot
  414. here is a possible directory tree (showing only the directories):
  415.      /usr
  416.       |
  417.       +--local
  418.       |   |
  419.       |   +--cvsroot
  420.       |   |    |
  421.       |   |    +--CVSROOT
  422.                |      (administrative files)
  423.                |
  424.                +--gnu
  425.                |   |
  426.                |   +--diff
  427.                |   |   (source code to GNU diff)
  428.                |   |
  429.                |   +--rcs
  430.                |   |   (source code to RCS)
  431.                |   |
  432.                |   +--cvs
  433.                |       (source code to CVS)
  434.                |
  435.                +--yoyodyne
  436.                    |
  437.                    +--tc
  438.                    |    |
  439.                    |    +--man
  440.                    |    |
  441.                    |    +--testing
  442.                    |
  443.                    +--(other Yoyodyne software)
  444.    With the directories are "history files" for each file under version
  445. control.  The name of the history file is the name of the corresponding
  446. file with `,v' appended to the end.  Here is what the repository for
  447. the `yoyodyne/tc' directory might look like:
  448.        `$CVSROOT'
  449.          |
  450.          +--yoyodyne
  451.          |   |
  452.          |   +--tc
  453.          |   |   |
  454.                  +--Makefile,v
  455.                  +--backend.c,v
  456.                  +--driver.c,v
  457.                  +--frontend.c,v
  458.                  +--parser.c,v
  459.                  +--man
  460.                  |    |
  461.                  |    +--tc.1,v
  462.                  |
  463.                  +--testing
  464.                       |
  465.                       +--testpgm.t,v
  466.                       +--test2.t,v
  467.    The history files contain, among other things, enough information to
  468. recreate any revision of the file, a log of all commit messages and the
  469. user-name of the person who committed the revision.  The history files
  470. are known as "RCS files", because the first program to store files in
  471. that format was a version control system known as RCS.  For a full
  472. description of the file format, see the `man' page `rcsfile(5)',
  473. distributed with RCS, or the file `doc/RCSFILES' in the CVS source
  474. distribution.  This file format has become very common--many systems
  475. other than CVS or RCS can at least import history files in this format.
  476.    The RCS files used in CVS differ in a few ways from the standard
  477. format.  The biggest difference is magic branches; for more information
  478. see *Note Magic branch numbers::.  Also in CVS the valid tag names are
  479. a subset of what RCS accepts; for CVS's rules see *Note Tags::.
  480. File: cvs.info,  Node: File permissions,  Next: Windows permissions,  Prev: Repository files,  Up: Repository storage
  481. File permissions
  482. ----------------
  483.    All `,v' files are created read-only, and you should not change the
  484. permission of those files.  The directories inside the repository
  485. should be writable by the persons that have permission to modify the
  486. files in each directory.  This normally means that you must create a
  487. UNIX group (see group(5)) consisting of the persons that are to edit
  488. the files in a project, and set up the repository so that it is that
  489. group that owns the directory.
  490.    This means that you can only control access to files on a
  491. per-directory basis.
  492.    Note that users must also have write access to check out files,
  493. because CVS needs to create lock files (*note Concurrency::.).
  494.    Also note that users must have write access to the
  495. `CVSROOT/val-tags' file.  CVS uses it to keep track of what tags are
  496. valid tag names (it is sometimes updated when tags are used, as well as
  497. when they are created).
  498.    Each RCS file will be owned by the user who last checked it in.
  499. This has little significance; what really matters is who owns the
  500. directories.
  501.    CVS tries to set up reasonable file permissions for new directories
  502. that are added inside the tree, but you must fix the permissions
  503. manually when a new directory should have different permissions than its
  504. parent directory.  If you set the `CVSUMASK' environment variable that
  505. will control the file permissions which CVS uses in creating directories
  506. and/or files in the repository.  `CVSUMASK' does not affect the file
  507. permissions in the working directory; such files have the permissions
  508. which are typical for newly created files, except that sometimes CVS
  509. creates them read-only (see the sections on watches, *Note Setting a
  510. watch::; -r, *Note Global options::; or CVSREAD, *Note Environment
  511. variables::).
  512.    Note that using the client/server CVS (*note Remote
  513. repositories::.), there is no good way to set `CVSUMASK'; the setting
  514. on the client machine has no effect.  If you are connecting with `rsh',
  515. you can set `CVSUMASK' in `.bashrc' or `.cshrc', as described in the
  516. documentation for your operating system.  This behavior might change in
  517. future versions of CVS; do not rely on the setting of `CVSUMASK' on the
  518. client having no effect.
  519.    Using pserver, you will generally need stricter permissions on the
  520. CVSROOT directory and directories above it in the tree; see *Note
  521. Password authentication security::.
  522.    Some operating systems have features which allow a particular
  523. program to run with the ability to perform operations which the caller
  524. of the program could not.  For example, the set user ID (setuid) or set
  525. group ID (setgid) features of unix or the installed image feature of
  526. VMS.  CVS was not written to use such features and therefore attempting
  527. to install CVS in this fashion will provide protection against only
  528. accidental lapses; anyone who is trying to circumvent the measure will
  529. be able to do so, and depending on how you have set it up may gain
  530. access to more than just CVS.  You may wish to instead consider
  531. pserver.  It shares some of the same attributes, in terms of possibly
  532. providing a false sense of security or opening security holes wider
  533. than the ones you are trying to fix, so read the documentation on
  534. pserver security carefully if you are considering this option (*Note
  535. Password authentication security::).
  536. File: cvs.info,  Node: Windows permissions,  Next: Attic,  Prev: File permissions,  Up: Repository storage
  537. File Permission issues specific to Windows
  538. ------------------------------------------
  539.    Some file permission issues are specific to Windows operating
  540. systems (Windows 95, Windows NT, and presumably future operating
  541. systems in this family.  Some of the following might apply to OS/2 but
  542. I'm not sure).
  543.    If you are using local CVS and the repository is on a networked file
  544. system which is served by the Samba SMB server, some people have
  545. reported problems with permissions.  Enabling WRITE=YES in the samba
  546. configuration is said to fix/workaround it.  Disclaimer: I haven't
  547. investigated enough to know the implications of enabling that option,
  548. nor do I know whether there is something which CVS could be doing
  549. differently in order to avoid the problem.  If you find something out,
  550. please let us know as described in *Note BUGS::.
  551. File: cvs.info,  Node: Attic,  Next: CVS in repository,  Prev: Windows permissions,  Up: Repository storage
  552. The attic
  553. ---------
  554.    You will notice that sometimes CVS stores an RCS file in the
  555. `Attic'.  For example, if the CVSROOT is `/usr/local/cvsroot' and we are
  556. talking about the file `backend.c' in the directory `yoyodyne/tc', then
  557. the file normally would be in
  558.      /usr/local/cvsroot/yoyodyne/tc/backend.c,v
  559.    but if it goes in the attic, it would be in
  560.      /usr/local/cvsroot/yoyodyne/tc/Attic/backend.c,v
  561.    instead.  It should not matter from a user point of view whether a
  562. file is in the attic; CVS keeps track of this and looks in the attic
  563. when it needs to.  But in case you want to know, the rule is that the
  564. RCS file is stored in the attic if and only if the head revision on the
  565. trunk has state `dead'.  A `dead' state means that file has been
  566. removed, or never added, for that revision.  For example, if you add a
  567. file on a branch, it will have a trunk revision in `dead' state, and a
  568. branch revision in a non-`dead' state.
  569. File: cvs.info,  Node: CVS in repository,  Next: Locks,  Prev: Attic,  Up: Repository storage
  570. The CVS directory in the repository
  571. -----------------------------------
  572.    The `CVS' directory in each repository directory contains
  573. information such as file attributes (in a file called `CVS/fileattr';
  574. see fileattr.h in the CVS source distribution for more documentation).
  575. In the future additional files may be added to this directory, so
  576. implementations should silently ignore additional files.
  577.    This behavior is implemented only by CVS 1.7 and later; for details
  578. see *Note Watches Compatibility::.
  579. File: cvs.info,  Node: Locks,  Next: CVSROOT storage,  Prev: CVS in repository,  Up: Repository storage
  580. CVS locks in the repository
  581. ---------------------------
  582.    For an introduction to CVS locks focusing on user-visible behavior,
  583. see *Note Concurrency::.  The following section is aimed at people who
  584. are writing tools which want to access a CVS repository without
  585. interfering with other tools acessing the same repository.  If you find
  586. yourself confused by concepts described here, like "read lock", "write
  587. lock", and "deadlock", you might consult the literature on operating
  588. systems or databases.
  589.    Any file in the repository with a name starting with `#cvs.rfl' is a
  590. read lock.  Any file in the repository with a name starting with
  591. `#cvs.wfl' is a write lock.  Old versions of CVS (before CVS 1.5) also
  592. created files with names starting with `#cvs.tfl', but they are not
  593. discussed here.  The directory `#cvs.lock' serves as a master lock.
  594. That is, one must obtain this lock first before creating any of the
  595. other locks.
  596.    To obtain a readlock, first create the `#cvs.lock' directory.  This
  597. operation must be atomic (which should be true for creating a directory
  598. under most operating systems).  If it fails because the directory
  599. already existed, wait for a while and try again.  After obtaining the
  600. `#cvs.lock' lock, create a file whose name is `#cvs.rfl' followed by
  601. information of your choice (for example, hostname and process
  602. identification number).  Then remove the `#cvs.lock' directory to
  603. release the master lock.  Then proceed with reading the repository.
  604. When you are done, remove the `#cvs.rfl' file to release the read lock.
  605.    To obtain a writelock, first create the `#cvs.lock' directory, as
  606. with a readlock.  Then check that there are no files whose names start
  607. with `#cvs.rfl'.  If there are, remove `#cvs.lock', wait for a while,
  608. and try again.  If there are no readers, then create a file whose name
  609. is `#cvs.wfl' followed by information of your choice (for example,
  610. hostname and process identification number).  Hang on to the
  611. `#cvs.lock' lock.  Proceed with writing the repository.  When you are
  612. done, first remove the `#cvs.wfl' file and then the `#cvs.lock'
  613. directory. Note that unlike the `#cvs.rfl' file, the `#cvs.wfl' file is
  614. just informational; it has no effect on the locking operation beyond
  615. what is provided by holding on to the `#cvs.lock' lock itself.
  616.    Note that each lock (writelock or readlock) only locks a single
  617. directory in the repository, including `Attic' and `CVS' but not
  618. including subdirectories which represent other directories under
  619. version control.  To lock an entire tree, you need to lock each
  620. directory (note that if you fail to obtain any lock you need, you must
  621. release the whole tree before waiting and trying again, to avoid
  622. deadlocks).
  623.    Note also that CVS expects writelocks to control access to
  624. individual `foo,v' files.  RCS has a scheme where the `,foo,' file
  625. serves as a lock, but CVS does not implement it and so taking out a CVS
  626. writelock is recommended.  See the comments at rcs_internal_lockfile in
  627. the CVS source code for further discussion/rationale.
  628. File: cvs.info,  Node: CVSROOT storage,  Prev: Locks,  Up: Repository storage
  629. How files are stored in the CVSROOT directory
  630. ---------------------------------------------
  631.    The `$CVSROOT/CVSROOT' directory contains the various administrative
  632. files.  In some ways this directory is just like any other directory in
  633. the repository; it contains RCS files whose names end in `,v', and many
  634. of the CVS commands operate on it the same way.  However, there are a
  635. few differences.
  636.    For each administrative file, in addition to the RCS file, there is
  637. also a checked out copy of the file.  For example, there is an RCS file
  638. `loginfo,v' and a file `loginfo' which contains the latest revision
  639. contained in `loginfo,v'.  When you check in an administrative file,
  640. CVS should print
  641.      cvs commit: Rebuilding administrative file database
  642. and update the checked out copy in `$CVSROOT/CVSROOT'.  If it does not,
  643. there is something wrong (*note BUGS::.).  To add your own files to the
  644. files to be updated in this fashion, you can add them to the
  645. `checkoutlist' administrative file.
  646.    By default, the `modules' file behaves as described above.  If the
  647. modules file is very large, storing it as a flat text file may make
  648. looking up modules slow (I'm not sure whether this is as much of a
  649. concern now as when CVS first evolved this feature; I haven't seen
  650. benchmarks).  Therefore, by making appropriate edits to the CVS source
  651. code one can store the modules file in a database which implements the
  652. `ndbm' interface, such as Berkeley db or GDBM.  If this option is in
  653. use, then the modules database will be stored in the files `modules.db',
  654. `modules.pag', and/or `modules.dir'.
  655.    For information on the meaning of the various administrative files,
  656. see *Note Administrative files::.
  657. File: cvs.info,  Node: Working directory storage,  Next: Intro administrative files,  Prev: Repository storage,  Up: Repository
  658. How data is stored in the working directory
  659. ===========================================
  660.    While we are discussing CVS internals which may become visible from
  661. time to time, we might as well talk about what CVS puts in the `CVS'
  662. directories in the working directories.  As with the repository, CVS
  663. handles this information and one can usually access it via CVS
  664. commands.  But in some cases it may be useful to look at it, and other
  665. programs, such as the `jCVS' graphical user interface or the `VC'
  666. package for emacs, may need to look at it.  Such programs should follow
  667. the recommendations in this section if they hope to be able to work
  668. with other programs which use those files, including future versions of
  669. the programs just mentioned and the command-line CVS client.
  670.    The `CVS' directory contains several files.  Programs which are
  671. reading this directory should silently ignore files which are in the
  672. directory but which are not documented here, to allow for future
  673. expansion.
  674. `Root'
  675.      This file contains the current CVS root, as described in *Note
  676.      Specifying a repository::.
  677. `Repository'
  678.      This file contains the directory within the repository which the
  679.      current directory corresponds with.  It can be either an absolute
  680.      pathname or a relative pathname; CVS has had the ability to read
  681.      either format since at least version 1.3 or so.  The relative
  682.      pathname is relative to the root, and is the more sensible
  683.      approach, but the absolute pathname is quite common and
  684.      implementations should accept either.  For example, after the
  685.      command
  686.           cvs -d :local:/usr/local/cvsroot checkout yoyodyne/tc
  687.      `Root' will contain
  688.           :local:/usr/local/cvsroot
  689.      and `Repository' will contain either
  690.           /usr/local/cvsroot/yoyodyne/tc
  691.      or
  692.           yoyodyne/tc
  693. `Entries'
  694.      This file lists the files and directories in the working
  695.      directory.  It is a text file according to the conventions
  696.      appropriate for the operating system in question.  The first
  697.      character of each line indicates what sort of line it is.  If the
  698.      character is unrecognized, programs reading the file should
  699.      silently skip that line, to allow for future expansion.
  700.      If the first character is `/', then the format is:
  701.           /NAME/REVISION/TIMESTAMP[+CONFLICT]/OPTIONS/TAGDATE
  702.      where `[' and `]' are not part of the entry, but instead indicate
  703.      that the `+' and conflict marker are optional.  NAME is the name
  704.      of the file within the directory.  REVISION is the revision that
  705.      the file in the working derives from, or `0' for an added file, or
  706.      `-' followed by a revision for a removed file.  TIMESTAMP is the
  707.      timestamp of the file at the time that CVS created it; if the
  708.      timestamp differs with the actual modification time of the file it
  709.      means the file has been modified.  It is in Universal Time (UT),
  710.      stored in the format used by the ISO C asctime() function (for
  711.      example, `Sun Apr  7 01:29:26 1996').  One may write a string
  712.      which is not in that format, for example, `Result of merge', to
  713.      indicate that the file should always be considered to be modified.
  714.      This is not a special case; to see whether a file is modified a
  715.      program should take the timestamp of the file and simply do a
  716.      string compare with TIMESTAMP.  CONFLICT indicates that there was
  717.      a conflict; if it is the same as the actual modification time of
  718.      the file it means that the user has obviously not resolved the
  719.      conflict.  OPTIONS contains sticky options (for example `-kb' for a
  720.      binary file).  TAGDATE contains `T' followed by a tag name, or `D'
  721.      for a date, followed by a sticky tag or date.  Note that if
  722.      TIMESTAMP contains a pair of timestamps separated by a space,
  723.      rather than a single timestamp, you are dealing with a version of
  724.      CVS earlier than CVS 1.5 (not documented here).
  725.      If the first character of a line in `Entries' is `D', then it
  726.      indicates a subdirectory.  `D' on a line all by itself indicates
  727.      that the program which wrote the `Entries' file does record
  728.      subdirectories (therefore, if there is such a line and no other
  729.      lines beginning with `D', one knows there are no subdirectories).
  730.      Otherwise, the line looks like:
  731.           D/NAME/FILLER1/FILLER2/FILLER3/FILLER4
  732.      where NAME is the name of the subdirectory, and all the FILLER
  733.      fields should be silently ignored, for future expansion.  Programs
  734.      which modify `Entries' files should preserve these fields.
  735. `Entries.Log'
  736.      This file does not record any information beyond that in
  737.      `Entries', but it does provide a way to update the information
  738.      without having to rewrite the entire `Entries' file, including the
  739.      ability to preserve the information even if the program writing
  740.      `Entries' and `Entries.Log' abruptly aborts.  Programs which are
  741.      reading the `Entries' file should also check for `Entries.Log'.
  742.      If the latter exists, they should read `Entries' and then apply
  743.      the changes mentioned in `Entries.Log'.  After applying the
  744.      changes, the recommended practice is to rewrite `Entries' and then
  745.      delete `Entries.Log'.  The format of a line in `Entries.Log' is a
  746.      single character command followed by a space followed by a line in
  747.      the format specified for a line in `Entries'.  The single
  748.      character command is `A' to indicate that the entry is being added,
  749.      `R' to indicate that the entry is being removed, or any other
  750.      character to indicate that the entire line in `Entries.Log' should
  751.      be silently ignored (for future expansion).  If the second
  752.      character of the line in `Entries.Log' is not a space, then it was
  753.      written by an older version of CVS (not documented here).
  754. `Entries.Backup'
  755.      This is a temporary file.  Recommended usage is to write a new
  756.      entries file to `Entries.Backup', and then to rename it
  757.      (atomically, where possible) to `Entries'.
  758. `Entries.Static'
  759.      The only relevant thing about this file is whether it exists or
  760.      not.  If it exists, then it means that only part of a directory
  761.      was gotten and CVS will not create additional files in that
  762.      directory.  To clear it, use the `update' command with the `-d'
  763.      option, which will get the additional files and remove
  764.      `Entries.Static'.
  765. `Tag'
  766.      This file contains per-directory sticky tags or dates.  The first
  767.      character is `T' for a branch tag, `N' for a non-branch tag, or
  768.      `D' for a date, or another character to mean the file should be
  769.      silently ignored, for future expansion.  This character is
  770.      followed by the tag or date.  Note that per-directory sticky tags
  771.      or dates are used for things like applying to files which are
  772.      newly added; they might not be the same as the sticky tags or
  773.      dates on individual files.  For general information on sticky tags
  774.      and dates, see *Note Sticky tags::.
  775. `Checkin.prog'
  776. `Update.prog'
  777.      These files store the programs specified by the `-i' and `-u'
  778.      options in the modules file, respectively.
  779. `Notify'
  780.      This file stores notifications (for example, for `edit' or
  781.      `unedit') which have not yet been sent to the server.  Its format
  782.      is not yet documented here.
  783. `Notify.tmp'
  784.      This file is to `Notify' as `Entries.Backup' is to `Entries'.
  785.      That is, to write `Notify', first write the new contents to
  786.      `Notify.tmp' and then (atomically where possible), rename it to
  787.      `Notify'.
  788. `Base'
  789.      If watches are in use, then an `edit' command stores the original
  790.      copy of the file in the `Base' directory.  This allows the
  791.      `unedit' command to operate even if it is unable to communicate
  792.      with the server.
  793. `Baserev'
  794.      The file lists the revision for each of the files in the `Base'
  795.      directory.  The format is:
  796.           BNAME/REV/EXPANSION
  797.      where EXPANSION should be ignored, to allow for future expansion.
  798. `Baserev.tmp'
  799.      This file is to `Baserev' as `Entries.Backup' is to `Entries'.
  800.      That is, to write `Baserev', first write the new contents to
  801.      `Baserev.tmp' and then (atomically where possible), rename it to
  802.      `Baserev'.
  803. `Template'
  804.      This file contains the template specified by the `rcsinfo' file
  805.      (*note rcsinfo::.).  It is only used by the client; the
  806.      non-client/server CVS consults `rcsinfo' directly.
  807. File: cvs.info,  Node: Intro administrative files,  Next: Multiple repositories,  Prev: Working directory storage,  Up: Repository
  808. The administrative files
  809. ========================
  810.    The directory `$CVSROOT/CVSROOT' contains some "administrative
  811. files".  *Note Administrative files::, for a complete description.  You
  812. can use CVS without any of these files, but some commands work better
  813. when at least the `modules' file is properly set up.
  814.    The most important of these files is the `modules' file.  It defines
  815. all modules in the repository.  This is a sample `modules' file.
  816.      CVSROOT         CVSROOT
  817.      modules         CVSROOT modules
  818.      cvs             gnu/cvs
  819.      rcs             gnu/rcs
  820.      diff            gnu/diff
  821.      tc              yoyodyne/tc
  822.    The `modules' file is line oriented.  In its simplest form each line
  823. contains the name of the module, whitespace, and the directory where
  824. the module resides.  The directory is a path relative to `$CVSROOT'.
  825. The last four lines in the example above are examples of such lines.
  826.    The line that defines the module called `modules' uses features that
  827. are not explained here.  *Note modules::, for a full explanation of all
  828. the available features.
  829. Editing administrative files
  830. ----------------------------
  831.    You edit the administrative files in the same way that you would edit
  832. any other module.  Use `cvs checkout CVSROOT' to get a working copy,
  833. edit it, and commit your changes in the normal way.
  834.    It is possible to commit an erroneous administrative file.  You can
  835. often fix the error and check in a new revision, but sometimes a
  836. particularly bad error in the administrative file makes it impossible
  837. to commit new revisions.
  838. File: cvs.info,  Node: Multiple repositories,  Next: Creating a repository,  Prev: Intro administrative files,  Up: Repository
  839. Multiple repositories
  840. =====================
  841.    In some situations it is a good idea to have more than one
  842. repository, for instance if you have two development groups that work
  843. on separate projects without sharing any code.  All you have to do to
  844. have several repositories is to specify the appropriate repository,
  845. using the `CVSROOT' environment variable, the `-d' option to CVS, or
  846. (once you have checked out a working directory) by simply allowing CVS
  847. to use the repository that was used to check out the working directory
  848. (*note Specifying a repository::.).
  849.    The big advantage of having multiple repositories is that they can
  850. reside on different servers.  The big disadvantage is that you cannot
  851. have a single CVS command recurse into directories which comes from
  852. different repositories.  Generally speaking, if you are thinking of
  853. setting up several repositories on the same machine, you might want to
  854. consider using several directories within the same repository.
  855.    None of the examples in this manual show multiple repositories.
  856. File: cvs.info,  Node: Creating a repository,  Next: Backing up,  Prev: Multiple repositories,  Up: Repository
  857. Creating a repository
  858. =====================
  859.    To set up a CVS repository, first choose the machine and disk on
  860. which you want to store the revision history of the source files.  CPU
  861. and memory requirements are modest, so most machines should be
  862. adequate.  For details see *Note Server requirements::.
  863.    To estimate disk space requirements, if you are importing RCS files
  864. from another system, the size of those files is the approximate initial
  865. size of your repository, or if you are starting without any version
  866. history, a rule of thumb is to allow for the server approximately three
  867. times the size of the code to be under CVS for the repository (you will
  868. eventually outgrow this, but not for a while).  On the machines on
  869. which the developers will be working, you'll want disk space for
  870. approximately one working directory for each developer (either the
  871. entire tree or a portion of it, depending on what each developer uses).
  872.    The repository should be accessable (directly or via a networked
  873. file system) from all machines which want to use CVS in server or local
  874. mode; the client machines need not have any access to it other than via
  875. the CVS protocol.  It is not possible to use CVS to read from a
  876. repository which one only has read access to; CVS needs to be able to
  877. create lock files (*note Concurrency::.).
  878.    To create a repository, run the `cvs init' command.  It will set up
  879. an empty repository in the CVS root specified in the usual way (*note
  880. Repository::.).  For example,
  881.      cvs -d /usr/local/cvsroot init
  882.    `cvs init' is careful to never overwrite any existing files in the
  883. repository, so no harm is done if you run `cvs init' on an already
  884. set-up repository.
  885.    `cvs init' will enable history logging; if you don't want that,
  886. remove the history file after running `cvs init'.  *Note history file::.
  887.